Get Party details (v1)

Get Party details

Query GET tag:Parties Internal

Overview

Get Party details

GET (/internal/v1/parties)

Parameters

  • userId (query): The user id for which associated parties are retrieved.

  • selfIndividual (query): When value is true, only the selfIndividualParty will be filtered and retrieved. Otherwise all user parties are retrieved.

  • username (query): The username for which associated parties are retrieved. The search can either be made by username or by userId.

  • originParty.qualifiedId (query): Optional qualified origin party id to filter parties linked to a specific origin party. Example: flexcube:LTT:123111121

  • offset (query): The position of the first result to be returned (pagination offset).

  • limit (query): The maximum number of results to return (pagination limit).

Responses

200 OK

Parties matching the provided filters.

400 Bad Request

Bad request response

404 Not Found

Not found error response

500 Internal Server Error

Internal server error response

Architecture

9 properties

Parties matching the provided filters.

count integer

Total number of parties matching the filter criteria

items array [object]

List of parties matching the filter criteria

7 properties

Bad request response

code string
Allowed values: urn:plmr:authentication:auth-orchestrator-api:INTERNAL_SERVER_ERROR urn:plmr:authentication:auth-orchestrator-api:BAD_REQUEST urn:plmr:authentication:auth-orchestrator-api:RESOURCE_UNKNOWN urn:plmr:authentication:auth-orchestrator-api:UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:INVALID_PARAM urn:plmr:authentication:auth-orchestrator-api:WEB_APPLICATION urn:plmr:authentication:auth-orchestrator-api:PARTY_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:MISSING_QUERY_PARAMS urn:plmr:authentication:auth-orchestrator-api:USER_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:DOMAIN_ORIGIN_PARTY_ALREADY_EXISTS
message string
requestId string
fieldErrors array [object]
3 properties

Not found error response

code string
Allowed values: urn:plmr:authentication:auth-orchestrator-api:INTERNAL_SERVER_ERROR urn:plmr:authentication:auth-orchestrator-api:BAD_REQUEST urn:plmr:authentication:auth-orchestrator-api:RESOURCE_UNKNOWN urn:plmr:authentication:auth-orchestrator-api:UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:INVALID_PARAM urn:plmr:authentication:auth-orchestrator-api:WEB_APPLICATION urn:plmr:authentication:auth-orchestrator-api:PARTY_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:MISSING_QUERY_PARAMS urn:plmr:authentication:auth-orchestrator-api:USER_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:DOMAIN_ORIGIN_PARTY_ALREADY_EXISTS
message string
requestId string
7 properties

Internal server error response

code string
Allowed values: urn:plmr:authentication:auth-orchestrator-api:INTERNAL_SERVER_ERROR urn:plmr:authentication:auth-orchestrator-api:BAD_REQUEST urn:plmr:authentication:auth-orchestrator-api:RESOURCE_UNKNOWN urn:plmr:authentication:auth-orchestrator-api:UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:INVALID_PARAM urn:plmr:authentication:auth-orchestrator-api:WEB_APPLICATION urn:plmr:authentication:auth-orchestrator-api:PARTY_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:MISSING_QUERY_PARAMS urn:plmr:authentication:auth-orchestrator-api:USER_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:DOMAIN_ORIGIN_PARTY_ALREADY_EXISTS
message string
requestId string
fieldErrors array [object]